home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / audio / ALgetname.z / ALgetname
Encoding:
Text File  |  2002-10-03  |  5.1 KB  |  133 lines
  1.  
  2.  
  3.  
  4. AAAALLLLggggeeeettttnnnnaaaammmmeeee((((3333ddddmmmm))))                                                  AAAALLLLggggeeeettttnnnnaaaammmmeeee((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ALgetname - (obsolete) returns a name for an audio device state variable
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiioooo....hhhh>>>>
  13.  
  14.      cccchhhhaaaarrrr**** AAAALLLLggggeeeettttnnnnaaaammmmeeee((((lllloooonnnngggg ddddeeeevvvviiiicccceeee,,,, lllloooonnnngggg ddddeeeessssccccrrrriiiippppttttoooorrrr))))
  15.  
  16. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  17.      _d_e_v_i_c_e       expects a device.  Currently there is only one device,
  18.                   AL_DEFAULT_DEVICE.
  19.  
  20.      _d_e_s_c_r_i_p_t_o_r   expects the descriptor (value of a symbolic constant) for
  21.                   the device state variable you want to identify.
  22.  
  23. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  24.      AAAALLLLggggeeeettttnnnnaaaammmmeeee is obsolete and is provided for backward compatibility. The
  25.      preferred function is aaaallllGGGGeeeettttPPPPaaaarrrraaaammmmIIIInnnnffffoooo((((3333ddddmmmm)))).
  26.  
  27.      AAAALLLLggggeeeettttnnnnaaaammmmeeee((((3333ddddmmmm)))) returns a pointer to a null-terminated string suitable for
  28.      use as a label to describe this state variable.  This string should be
  29.      considered "read only".
  30.  
  31.      Subsequent calls to AAAALLLLggggeeeettttnnnnaaaammmmeeee((((3333ddddmmmm)))) may over-write the contents of the
  32.      returned string. If you rely upon the value of this string, you should
  33.      copy it before again calling AAAALLLLggggeeeettttnnnnaaaammmmeeee((((3333ddddmmmm)))).
  34.  
  35.      The current mapping between device state variables and names is:  [not
  36.      all parameters are present on all systems]
  37.  
  38.           AL_INPUT_SOURCE     "Line/MIC/AES"
  39.           AL_LEFT_INPUT_ATTEN      "Left Input Atten"
  40.           AL_RIGHT_INPUT_ATTEN     "Right Input Atten"
  41.           AL_INPUT_RATE       "Input Rate"
  42.           AL_OUTPUT_RATE      "Output Rate"
  43.           AL_LEFT_SPEAKER_GAIN     "Left Output Gain"
  44.           AL_RIGHT_SPEAKER_GAIN    "Right Output Gain"
  45.           AL_INPUT_COUNT      "Input Count"
  46.           AL_OUTPUT_COUNT          "Output Count"
  47.           AL_UNUSED_COUNT          "Unused Count"
  48.           AL_SYNC_INPUT_TO_AES     "Sync input to AES input"
  49.           AL_SYNC_OUTPUT_TO_AES    "Sync output to AES input"
  50.           AL_MONITOR_CTL          "Monitor control"
  51.           AL_LEFT_MONITOR_ATTEN   "Left monitor atten"
  52.           AL_RIGHT_MONITOR_ATTEN  "Right monitor atten"
  53.           AL_SPEAKER_MUTE_CTL     "Speaker mute control"
  54.           AL_MIC_MODE         "Microphone mode"
  55.           AL_CHANNEL_MODE          "System Channel Mode"
  56.           AL_DIGITAL_INPUT_RATE    "Digital Input Rate"
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. AAAALLLLggggeeeettttnnnnaaaammmmeeee((((3333ddddmmmm))))                                                  AAAALLLLggggeeeettttnnnnaaaammmmeeee((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74.      To get descriptors for all the state variables associated with a device,
  75.      call AAAALLLLqqqquuuueeeerrrryyyyppppaaaarrrraaaammmmssss((((3333ddddmmmm)))).
  76.  
  77.      AAAALLLLggggeeeettttnnnnaaaammmmeeee((((3333ddddmmmm)))) can fail for the following reasons:
  78.  
  79.      AAAALLLL____BBBBAAAADDDD____DDDDEEEEVVVVIIIICCCCEEEE          _d_e_v_i_c_e is invalid.
  80.  
  81.      AAAALLLL____BBBBAAAADDDD____DDDDEEEEVVVVIIIICCCCEEEE____AAAACCCCCCCCEEEESSSSSSSS   audio hardware is inaccessible.
  82.  
  83.      AAAALLLL____BBBBAAAADDDD____PPPPAAAARRRRAAAAMMMM           _d_e_s_c_r_i_p_t_o_r is not valid for _d_e_v_i_c_e.
  84.  
  85. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  86.      In the case of failure, AAAALLLLggggeeeettttnnnnaaaammmmeeee((((3333ddddmmmm)))) returns a null-valued pointer and
  87.      sets an error number which can be retrieved with oooosssseeeerrrrrrrroooorrrr((((3333CCCC)))).
  88.  
  89. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  90.      ALqueryparams(3dm), ALgetminmax(3dm), ALgetdefault(3dm), oserror(3C)
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.